home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / cmds.fmt / grn.man < prev    next >
Encoding:
Text File  |  1989-01-19  |  7.1 KB  |  199 lines
  1.  
  2.  
  3.  
  4. GRN                       User Commands                       GRN
  5.  
  6.  
  7.  
  8. NNAAMMEE
  9.      grn - ditroff preprocessor for gremlin files
  10.  
  11. SSYYNNOOPPSSIISS
  12.      ggrrnn [ options ] ... [ _f_i_l_e ] ...
  13.  
  14. DDEESSCCRRIIPPTTIIOONN
  15.      _G_r_n is a preprocessor for including _g_r_e_m_l_i_n pictures in
  16.      _d_i_t_r_o_f_f input.  _G_r_n writes to standard output, processing
  17.      only input lines between two that start with `.GS' and
  18.      `.GE'.  Those lines must contain _g_r_n commands (see below).
  19.      These commands request a gremlin file, and the picture in
  20.      that file is converted and placed in the ditroff input
  21.      stream.  The .GS may be followed by a C, L, or R to center,
  22.      left or right justify the whole gremlin picture (default
  23.      justification is center).  If no _f_i_l_e is mentioned, the
  24.      standard input is read.  At the end of the picture, the
  25.      position on the page is the bottom of the gremlin picture.
  26.      If the grn entry is ended with `.GF' instead of `.GE', the
  27.      position is left at the top of the picture.  The following
  28.      command-line options are understood:
  29.  
  30.      --PP_d_e_v
  31.           Prepare output for printer _d_e_v.  The default is varian
  32.           (or versatec since the two are equivalent).  See ditr-
  33.           off(1) for acceptable dev's.
  34.  
  35.      --LL_d_i_r
  36.           Set the library to directory _d_i_r.  If a gremlin file
  37.           cannot be found in the current directory, _d_i_r is
  38.           prepended to the filename for a second try.  The
  39.           default library directory is /usr/local/gremlib.
  40.  
  41. GGRRNN CCOOMMMMAANNDDSS
  42.      Each input line between the `.GS' and `.GE' may have one grn
  43.      command.  Commands consist of one or two strings separated
  44.      by white space, the first string being the command and the
  45.      second its operand.  Commands may be upper or lower case and
  46.      abbreviated down to one character.
  47.  
  48.      Commands that affect a picture's environment (those listed
  49.      before ddeeffaauulltt, below) are only in effect for the current
  50.      picture: the environment is reinitialized to the defaults at
  51.      the start of the next picture.  The commands are as follows:
  52.  
  53.      11 _N  (22, 33, or 44)  Set gremlin's text size number 1 (2, 3,
  54.           or 4) to _N points.  The default is 12 (16, 24, and 36).
  55.  
  56.      rroommaann _f_f
  57.           (iittaalliiccss, bboolldd, or ssppeecciiaall)  Set the roman (italics,
  58.           bold, or special) font to ditroff's font _f_f (either a
  59.           name or number).  The default is R (I, B, and S).
  60.  
  61.  
  62.  
  63. Sprite v1.0                   local                             1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. GRN                       User Commands                       GRN
  71.  
  72.  
  73.  
  74.      ll _N  Set the stipple font to ditroff's stipple font _f_f (name
  75.           or number).  The command ssttiippppllee can be substituted,
  76.           but only abbreviated down as far as `st' to avoid con-
  77.           fusion with special.  There is NO default for stipples
  78.           (unless one is set by the default command), and it is
  79.           illegal to include a gremlin picture with polygons
  80.           without specifying a stipple font.
  81.  
  82.      xx _N  Magnify the picture (in addition to any default magnif-
  83.           ication) by _N, a floating point number > 0.  The com-
  84.           mand ssccaallee may be substituted, abbreviated down to
  85.           `sc'.
  86.  
  87.      nnaarrrrooww _N
  88.           (mmeeddiiuumm, or tthhiicckk)  Set the thickness of gremlin's nar-
  89.           row (medium or thick) lines to _N.  The default is 1 (3
  90.           and 5) pixels.
  91.  
  92.      ppooiinnttssccaallee <_o_f_f/_o_n>
  93.           Scale text to match the picture.  Gremlin text is usu-
  94.           ally printed in the point size specified in 1, 2, 3 or
  95.           4 regardless of any scaling factors in the picture.
  96.           Setting ppooiinnttssccaallee will cause the point sizes to scale
  97.           with the picture (within ditroff's limitations, of
  98.           course).  An operand of anything but _o_f_f will turn text
  99.           scaling on.
  100.  
  101.      ddeeffaauulltt
  102.           Reset the picture environment defaults to the settings
  103.           in the current picture.  This is meant to be used as a
  104.           global parameter setting mechanism at the beginning of
  105.           the ditroff input file, but can be used at any time to
  106.           reset the default settings.
  107.  
  108.      wwiiddtthh _N
  109.           Forces the picture to be _N inches wide.  This overrides
  110.           any scaling factors present in the same picture.  wwiiddtthh
  111.           _0 is ignored.
  112.  
  113.      hheeiigghhtt _N
  114.           Forces picture to be _N inches high, overriding other
  115.           scaling factors.  If both ``width'' and ``height'' are
  116.           specified the tighter constraint will determine the
  117.           scale of the picture.  HHeeiigghhtt and wwiiddtthh commands are
  118.           not saved with a ddeeffaauulltt command.  They will, however,
  119.           affect point size scaling if that option is set.
  120.  
  121.      ffiillee _n_a_m_e
  122.           Get picture from gremlin file _n_a_m_e from the current
  123.           directory (or in the library directory see the --LL
  124.           option above).  If two ffiillee commands are given, the
  125.           second one overrides the first.  If _n_a_m_e doesn't exist,
  126.  
  127.  
  128.  
  129. Sprite v1.0                   local                             2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. GRN                       User Commands                       GRN
  137.  
  138.  
  139.  
  140.           an error message is reported and processing continues
  141.           from the .GE line.
  142.  
  143. NNOOTTEESS AABBOOUUTT DDIITTRROOFFFF
  144.      Since _g_r_n is a preprocessor, it doesn't know about current
  145.      indents, point sizes, margins, number registers, etc.  Con-
  146.      sequently, no troff input can be placed between the ``.GS''
  147.      and ``.GE''.  However, gremlin text is now processed by
  148.      troff, so anything legal in a single line of troff input is
  149.      legal in a line of gremlin text (barring ``.'' directives at
  150.      the beginning of a line).
  151.  
  152.      When using grn along with other preprocessors, it is best to
  153.      run tbl before grn, pic, and/or ideal to avoid overworking
  154.      tbl.  Eqn should always be run last.
  155.  
  156.      A picture is considered an entity, but that doesn't stop
  157.      troff from trying to break it up if it falls off the end of
  158.      a page.  Placing the picture between ``keeps'' in either the
  159.      -ms or -me macros will ensure proper placement.
  160.  
  161.      The .GS and .GE lines are sent through to ditroff and used
  162.      in the -ms and -me macros for adjusting the picture.  There
  163.      are -mg macros available for grn, pic and ideal if you don't
  164.      use -ms or -me.  Grn uses number registers g1 through g9 and
  165.      sets register g1 and g2 to the width and height of the grem-
  166.      lin figure (in device units) before entering the .GS (this
  167.      is for those who want to rewrite these macros).
  168.  
  169. FFIILLEESS
  170.      /usr/lib/font/dev_x_x_x/DESC.out device _x_x_x description file
  171.  
  172. SSEEEE AALLSSOO
  173.      gremlin(l), ditroff(1), pic(1), ideal(1)
  174.  
  175. AAUUTTHHOORR
  176.      David Slattengren
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195. Sprite v1.0                   local                             3
  196.  
  197.  
  198.  
  199.